4.4 查询本地用户角色(支持根据name查询)
基本信息
Path: /api/v2/localUserRole/queryById
Method: GET
接口描述:
请求参数
Query
根据id查询
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
id | 必须 | 用户角色ID |
根据name查询
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
name | 必须 | 用户角色名 |
- 如果响应状态码为401且控制台【审计中心/设备安全日志】中存在接口攻击行为日志,处置原因为[SNORT]SNORT ACTION: BLOCK。说明是设备检测到了请求中存在攻击特征,触发了自动拦截。请检查name参数中是否存在SQL或命令注入特征,如select、delete等关键字,如果存在请修改角色名后重试。如需协助,可联系深信服客户服务热线:400-630-6430。
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 返回编码 0 成功 其它值,失败 | ||
data | object | 必须 | 数据主体 | ||
├─ data | object | 必须 | 返回数据 | ||
├─├─ id | string | 必须 | 用户角色ID | ||
├─├─ name | string | 必须 | 用户角色名称 | ||
├─├─ description | string | 必须 | 描述 | ||
├─├─ resourceList | object[] | 非必须 | 直接关联的应用和应用分类 | ||
├─├─├─ dataType | string | 非必须 | resource为应用,group为应用分类 | ||
├─├─├─ id | string | 非必须 | 应用/应用分类ID | ||
├─├─├─ name | string | 非必须 | 应用/应用分类名 | ||
├─├─├─ accessModel | string | 非必须 | 应用接入类型,WEB,L3VPN(应该分类无此字段) | ||
├─├─├─ description | string | 非必须 | 应用/应用分类描述 | ||
├─├─├─ status | string | 非必须 | 启用状态,0禁用,1启用 | ||
├─├─ userList | object[] | 非必须 | 适用对象-用户 | >=2.2.16后支持返回该字段 | |
├─├─├─ id | string | 非必须 | 用户id | ||
├─├─├─ name | string | 非必须 | 用户名 | ||
├─├─├─ displayName | string | 非必须 | 用户显示名 | ||
├─├─├─ path | string | 非必须 | 所属组织架构 | ||
├─├─ groupList | object[] | 非必须 | 适用对象-组织架构 | >=2.2.16后支持返回该字段 | |
├─├─├─ id | string | 非必须 | 组织架构id | ||
├─├─├─ name | string | 非必须 | 组织架构名 | ||
├─├─├─ path | string | 非必须 | 所属组织架构 | ||
msg | string | 必须 | code对应的提示信息 |
返回示例
{
"code": 0,
"data": {
"data": {
"id": "2d9a39f0-3ae4-11ed-900c-c19b9dc9f6e2",
"name": "角色名",
"resourceCount": 3,
"description": "角色描述",
"resourceList": [
{
"name": "应用分类1",
"status": 1,
"description": "描述",
"id": "66c78340-3efe-11ed-ad05-a5bbb7baeda1",
"dataType": "group"
},
{
"name": "隧道1",
"accessModel": "L3VPN",
"status": 1,
"level": "3",
"description": "",
"id": "022dd1d0-3f0f-11ed-804e-031ce827e394",
"iconId": "1",
"iconType": "font",
"iconPath": "/portal/preset_icon/1.png",
"dataType": "resource",
"subModel": "L3VPN",
"extendModel": ""
}
],
"inheritResource": {},
"userList": [
{
"id": "5204fc10-ad0a-11ed-a413-e760e7fa79c8",
"name": "q1",
"path": "/",
"displayName": "q1"
},
{
"id": "5b308ca0-ad0a-11ed-a413-e760e7fa79c8",
"name": "q2",
"path": "/",
"displayName": "q2"
}
],
"groupList": [
{
"id": "014b1f80-acd7-11ed-bc74-15bff46e4d9b",
"name": "root",
"path": "/"
},
{
"id": "051e6ea0-acd7-11ed-bc74-15bff46e4d9b",
"name": "t1",
"path": "/t"
}
]
}
},
"msg": "请求成功",
"traceId": "010d5212b2cf3dd2"
}
错误信息
错误提示 | 错误码 |
---|---|
参数检查出错 | 10000001 |
操作失败,对象不存在或已被其他管理员删除 | 77200004 |